Add docs for API v2 - #100
Draft
Chew wants to merge 8 commits into
Draft
Conversation
Member
|
I have a few goals for the V2 API documentation:
A big open question is how the spec will actually get published. I'm thinking maybe we can have a GitHub Action that emits openapi.json upon commits to RAWeb's |
This was referenced Jul 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This will be a draft for a while, but this PR adds docs for the new JSON:API v2 changes to RAWeb.
This also adds an OpenAPI spec for all of the endpoints.
The sidebar changes allows there to be v1 and v2 docs. Most v2 pages, including the sidebar, are generated from the spec. The ultimate goal is to make it easy to add new endpoints and add examples if desired.
For now, it's a mess, until we really decide what we want. But for now, I just wanted to get this started.
The full spec is currently here: https://github.com/Chew/RA-api-docs/blob/feat/v2-docs/docs/v2/retroachievements.json